\hypertarget{class_zebulon_1_1_underwater_1_1_set_motor_thrust}{
\section{Zebulon::Underwater::SetMotorThrust Class Reference}
\label{class_zebulon_1_1_underwater_1_1_set_motor_thrust}\index{Zebulon::Underwater::SetMotorThrust@{Zebulon::Underwater::SetMotorThrust}}
}


Command message to set the desired thrust of a motor.  


{\ttfamily \#include $<$setmotorthrust.h$>$}Inheritance diagram for Zebulon::Underwater::SetMotorThrust::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{class_zebulon_1_1_underwater_1_1_set_motor_thrust}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum {\bfseries Motor} \{ \par
{\bfseries Left} =  0x60, 
{\bfseries Right} =  0x70, 
{\bfseries Vertical} =  0x80, 
{\bfseries Horizontal} =  0xFE, 
\par
{\bfseries All} =  0xFF
 \}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a3642be7be6eb04a6c208a2e878ffa1b9}{
\hyperlink{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a3642be7be6eb04a6c208a2e878ffa1b9}{SetMotorThrust} ()}
\label{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a3642be7be6eb04a6c208a2e878ffa1b9}

\begin{DoxyCompactList}\small\item\em Constructor. \item\end{DoxyCompactList}\item 
\hypertarget{class_zebulon_1_1_underwater_1_1_set_motor_thrust_afeb177e2267c2d89b9a7d18cfc84e925}{
virtual \hyperlink{class_zebulon_1_1_underwater_1_1_set_motor_thrust_afeb177e2267c2d89b9a7d18cfc84e925}{$\sim$SetMotorThrust} ()}
\label{class_zebulon_1_1_underwater_1_1_set_motor_thrust_afeb177e2267c2d89b9a7d18cfc84e925}

\begin{DoxyCompactList}\small\item\em Destructor. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a29b2afcad3c2f731e687f4c8bcebcad8}{WriteMessageBody} (CxUtils::Packet \&packet) const 
\begin{DoxyCompactList}\small\item\em Writes the contents of the message payload to the packet. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a7d80f9920172c89ed9b448acc303f613}{ReadMessageBody} (const CxUtils::Packet \&packet)
\begin{DoxyCompactList}\small\item\em Reads the contents of the message payload from the packet, and saves to internal data members. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a88e248296e8800278d1605d45beb2f15}{SetThrust} (Motor motor, double thrust)
\begin{DoxyCompactList}\small\item\em Sets member thrust variables. \item\end{DoxyCompactList}\item 
\hypertarget{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a5f1eee225d22439d457e92b43e3b9ace}{
virtual int {\bfseries SetMotor} (Motor motor)}
\label{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a5f1eee225d22439d457e92b43e3b9ace}

\item 
\hypertarget{class_zebulon_1_1_underwater_1_1_set_motor_thrust_ad884805b9fe9fed2753581931db0c39a}{
virtual void {\bfseries Print} () const }
\label{class_zebulon_1_1_underwater_1_1_set_motor_thrust_ad884805b9fe9fed2753581931db0c39a}

\item 
\hypertarget{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a660c78d98979fb807029921e80e90063}{
virtual Message $\ast$ \hyperlink{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a660c78d98979fb807029921e80e90063}{Clone} () const }
\label{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a660c78d98979fb807029921e80e90063}

\begin{DoxyCompactList}\small\item\em Makes a clone of the message. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Command message to set the desired thrust of a motor. 

\subsection{Member Function Documentation}
\hypertarget{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a7d80f9920172c89ed9b448acc303f613}{
\index{Zebulon::Underwater::SetMotorThrust@{Zebulon::Underwater::SetMotorThrust}!ReadMessageBody@{ReadMessageBody}}
\index{ReadMessageBody@{ReadMessageBody}!Zebulon::Underwater::SetMotorThrust@{Zebulon::Underwater::SetMotorThrust}}
\subsubsection[{ReadMessageBody}]{\setlength{\rightskip}{0pt plus 5cm}int SetMotorThrust::ReadMessageBody (const CxUtils::Packet \& {\em packet})\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a7d80f9920172c89ed9b448acc303f613}


Reads the contents of the message payload from the packet, and saves to internal data members. 
\begin{DoxyParams}{Parameters}
\item[\mbox{$\leftarrow$} {\em packet}]Packet to read from.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
4 on success, 0 on failure. 
\end{DoxyReturn}


Reimplemented from \hyperlink{class_zebulon_1_1_m_c_u_1_1_message}{Zebulon::MCU::Message}.\hypertarget{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a88e248296e8800278d1605d45beb2f15}{
\index{Zebulon::Underwater::SetMotorThrust@{Zebulon::Underwater::SetMotorThrust}!SetThrust@{SetThrust}}
\index{SetThrust@{SetThrust}!Zebulon::Underwater::SetMotorThrust@{Zebulon::Underwater::SetMotorThrust}}
\subsubsection[{SetThrust}]{\setlength{\rightskip}{0pt plus 5cm}int SetMotorThrust::SetThrust (Motor {\em motor}, \/  double {\em thrust})\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a88e248296e8800278d1605d45beb2f15}


Sets member thrust variables. 
\begin{DoxyParams}{Parameters}
\item[\mbox{$\leftarrow$} {\em motor}]Motor enum of the motors you wish to set thrust to\item[\mbox{$\leftarrow$} {\em thrust}]Thrust value as a percentage \mbox{[}-\/100,100\mbox{]}\end{DoxyParams}
\begin{DoxyReturn}{Returns}
1 on success, 0 on failure. 
\end{DoxyReturn}
\hypertarget{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a29b2afcad3c2f731e687f4c8bcebcad8}{
\index{Zebulon::Underwater::SetMotorThrust@{Zebulon::Underwater::SetMotorThrust}!WriteMessageBody@{WriteMessageBody}}
\index{WriteMessageBody@{WriteMessageBody}!Zebulon::Underwater::SetMotorThrust@{Zebulon::Underwater::SetMotorThrust}}
\subsubsection[{WriteMessageBody}]{\setlength{\rightskip}{0pt plus 5cm}int SetMotorThrust::WriteMessageBody (CxUtils::Packet \& {\em packet}) const\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}
\label{class_zebulon_1_1_underwater_1_1_set_motor_thrust_a29b2afcad3c2f731e687f4c8bcebcad8}


Writes the contents of the message payload to the packet. 
\begin{DoxyParams}{Parameters}
\item[\mbox{$\leftarrow$} {\em packet}]Packet to write to.\end{DoxyParams}
\begin{DoxyReturn}{Returns}
4 on success, 0 on failure. 
\end{DoxyReturn}


Reimplemented from \hyperlink{class_zebulon_1_1_m_c_u_1_1_message}{Zebulon::MCU::Message}.

The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
C:/Users/Matt/Documents/School/Robotics/zebulon/v2/underwater/include/underwater/messages/\hyperlink{setmotorthrust_8h}{setmotorthrust.h}\item 
C:/Users/Matt/Documents/School/Robotics/zebulon/v2/underwater/src/underwater/messages/\hyperlink{setmotorthrust_8cpp}{setmotorthrust.cpp}\end{DoxyCompactItemize}
